GET
/
v1
/
inventory
/
warehouses
/
{id}
/
locations
/
{location_id}
Get one Location
curl --request GET \
  --url https://{client_id}.shipstream.app/api/global/v1/inventory/warehouses/{id}/locations/{location_id}
{
  "resource": {
    "type": "Location",
    "id": 42,
    "label": "A4-55-C3",
    "priority": 10,
    "qty_putaway": 10,
    "qty_unreserved": 20,
    "qty_reserved": 4,
    "qty_on_hand": 34,
    "qty_locked": 4,
    "is_temp": false,
    "is_pickable": true,
    "is_type_auto": true,
    "created_at": "2021-11-17T14:32:44Z",
    "updated_at": "2021-11-17T14:32:44Z",
    "last_cyclecount_at": "2021-11-17T14:32:44Z",
    "lot": {
      "type": "Lot",
      "id": 54
    },
    "product": {
      "type": "Product",
      "id": 123
    },
    "rack": {
      "type": "Rack",
      "id": 123
    },
    "location_type": {
      "type": "LocationType",
      "id": 54
    }
  },
  "included": {
    "LocationType": [
      {
        "type": "LocationType",
        "id": 54,
        "name": "Pickable Pallets",
        "is_pickable": false
      }
    ],
    "Lot": [
      {
        "type": "Lot",
        "id": 54
      }
    ],
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Rack": [
      {
        "type": "Rack",
        "id": 54
      }
    ]
  }
}

Path Parameters

id
integer
required

The id of the referenced Warehouse.

location_id
integer
required

The id of the referenced Location.

Query Parameters

fields:lot
enum<string>[]

Specify additional fields of the Lot object to be included in the response. See the selecting fields page for more information.

fields:product
enum<string>[]

Specify additional fields of the Product or Packaging* object to be included in the response. See the selecting fields page for more information.

fields:rack
enum<string>[]

Specify additional fields of the Rack object to be included in the response. See the selecting fields page for more information.

fields:location_type
enum<string>[]

Specify additional fields of the LocationType object to be included in the response. See the selecting fields page for more information.

Response

200
application/json

OK

The response is of type object.